<!DOCTYPE html>
<html lang="en">
  <head>
    <title>KingfisherWrapper Structure Reference</title>
    <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    <meta charset="utf-8">
    <script src="../js/jquery.min.js" defer></script>
    <script src="../js/jazzy.js" defer></script>
    
    <script src="../js/lunr.min.js" defer></script>
    <script src="../js/typeahead.jquery.js" defer></script>
    <script src="../js/jazzy.search.js" defer></script>
  </head>
  <body>

    <a name="//apple_ref/swift/Struct/KingfisherWrapper" class="dashAnchor"></a>

    <a title="KingfisherWrapper Structure Reference"></a>

    <header class="header">
      <p class="header-col header-col--primary">
        <a class="header-link" href="../index.html">
          Kingfisher 5.12.0 Docs
        </a>
         (83% documented)
      </p>
    
      <p class="header-col--secondary">
        <form role="search" action="../search.json">
          <input type="text" placeholder="Search documentation" data-typeahead>
        </form>
      </p>
    
        <p class="header-col header-col--secondary">
          <a class="header-link" href="https://github.com/onevcat/Kingfisher">
            <img class="header-icon" src="../img/gh.png"/>
            View on GitHub
          </a>
        </p>
    
        <p class="header-col header-col--secondary">
          <a class="header-link" href="dash-feed://http%3A%2F%2Fonevcat%2Egithub%2Eio%2FKingfisher%2Fdocsets%2FKingfisher%2Exml">
            <img class="header-icon" src="../img/dash.png"/>
            Install in Dash
          </a>
        </p>
    </header>

    <p class="breadcrumbs">
      <a class="breadcrumb" href="../index.html">Kingfisher Reference</a>
      <img class="carat" src="../img/carat.png" />
      KingfisherWrapper Structure Reference
    </p>

    <div class="content-wrapper">
      <nav class="navigation">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/AnimatedImageView.html">AnimatedImageView</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/AnimatedImageView/RepeatCount.html">– RepeatCount</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/ImageCache.html">ImageCache</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/ImageDownloader.html">ImageDownloader</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/ImagePrefetcher.html">ImagePrefetcher</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/KingfisherManager.html">KingfisherManager</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/RetrieveImageTask.html">RetrieveImageTask</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/SessionDataTask.html">SessionDataTask</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Global%20Variables.html#/s:10Kingfisher0A23DiskCacheCleanedHashKeySSvp">KingfisherDiskCacheCleanedHashKey</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Global%20Variables.html#/s:10Kingfisher0A11ErrorDomainSSvp">KingfisherErrorDomain</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/CacheType.html">CacheType</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/CallbackQueue.html">CallbackQueue</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/ContentMode.html">ContentMode</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/DiskStorage.html">DiskStorage</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/DiskStorage/Backend.html">– Backend</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/DiskStorage/Config.html">– Config</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/ExpirationExtending.html">ExpirationExtending</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/ImageCacheResult.html">ImageCacheResult</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/ImageFormat.html">ImageFormat</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/ImageFormat/JPEGMarker.html">– JPEGMarker</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/ImageProcessItem.html">ImageProcessItem</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/ImageTransition.html">ImageTransition</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/ImageTransition.html">ImageTransition</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/IndicatorSizeStrategy.html">IndicatorSizeStrategy</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/IndicatorType.html">IndicatorType</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/KingfisherError.html">KingfisherError</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/KingfisherError/RequestErrorReason.html">– RequestErrorReason</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/KingfisherError/ResponseErrorReason.html">– ResponseErrorReason</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/KingfisherError/CacheErrorReason.html">– CacheErrorReason</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/KingfisherError/ProcessorErrorReason.html">– ProcessorErrorReason</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/KingfisherError/ImageSettingErrorReason.html">– ImageSettingErrorReason</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/KingfisherOptionsInfoItem.html">KingfisherOptionsInfoItem</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/MemoryStorage.html">MemoryStorage</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/MemoryStorage/Backend.html">– Backend</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/MemoryStorage/Config.html">– Config</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/Source.html">Source</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/Source/Identifier.html">– Identifier</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/StorageExpiration.html">StorageExpiration</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions.html#/c:@S@CGSize">CGSize</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions/Collection.html">Collection</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions/Data.html">Data</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions.html#/s:10Kingfisher21KFCrossPlatformButtona">KFCrossPlatformButton</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions/KFCrossPlatformImage.html">KFCrossPlatformImage</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions.html#/s:10Kingfisher24KFCrossPlatformImageViewa">KFCrossPlatformImageView</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions/KingfisherWrapper.html">KingfisherWrapper</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions/Notification/Name.html">– Name</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)UIApplication">UIApplication</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Extensions.html#/WKInterfaceImage">WKInterfaceImage</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Functions.html">Functions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Functions.html#/s:10Kingfisher2ggoiyAA14ImageProcessor_pAaC_p_AaC_ptF">&gt;&gt;(_:_:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Functions.html#/s:10Kingfisher2ogoiyAA14ImageProcessor_pAaC_p_AaC_ptF">|&gt;(_:_:)</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/AnimatedImageViewDelegate.html">AnimatedImageViewDelegate</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/AuthenticationChallengeResponsable.html">AuthenticationChallengeResponsable</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/CIImageProcessor.html">CIImageProcessor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/CacheCostCalculable.html">CacheCostCalculable</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/CacheSerializer.html">CacheSerializer</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/DataTransformable.html">DataTransformable</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/ImageDataProvider.html">ImageDataProvider</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/ImageDownloadRedirectHandler.html">ImageDownloadRedirectHandler</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/ImageDownloadRequestModifier.html">ImageDownloadRequestModifier</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/ImageDownloaderDelegate.html">ImageDownloaderDelegate</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/ImageModifier.html">ImageModifier</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/ImageProcessor.html">ImageProcessor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/Indicator.html">Indicator</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/KingfisherCompatible.html">KingfisherCompatible</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/KingfisherCompatibleValue.html">KingfisherCompatibleValue</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/Placeholder.html">Placeholder</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/Resource.html">Resource</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Structs.html">Structures</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/AlignmentRectInsetsImageModifier.html">AlignmentRectInsetsImageModifier</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/AnyImageModifier.html">AnyImageModifier</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/AnyModifier.html">AnyModifier</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/AnyRedirectHandler.html">AnyRedirectHandler</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/Base64ImageDataProvider.html">Base64ImageDataProvider</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/BlackWhiteProcessor.html">BlackWhiteProcessor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/BlendImageProcessor.html">BlendImageProcessor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/BlurImageProcessor.html">BlurImageProcessor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/CacheStoreResult.html">CacheStoreResult</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/ColorControlsProcessor.html">ColorControlsProcessor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/CompositingImageProcessor.html">CompositingImageProcessor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/CroppingImageProcessor.html">CroppingImageProcessor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/DefaultCacheSerializer.html">DefaultCacheSerializer</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/DefaultImageModifier.html">DefaultImageModifier</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/DefaultImageProcessor.html">DefaultImageProcessor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/DownsamplingImageProcessor.html">DownsamplingImageProcessor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/Filter.html">Filter</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/FlipsForRightToLeftLayoutDirectionImageModifier.html">FlipsForRightToLeftLayoutDirectionImageModifier</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/FormatIndicatedCacheSerializer.html">FormatIndicatedCacheSerializer</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/ImageCreatingOptions.html">ImageCreatingOptions</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/ImageLoadingResult.html">ImageLoadingResult</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/ImageProgressive.html">ImageProgressive</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/ImageResource.html">ImageResource</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/KingfisherParsedOptionsInfo.html">KingfisherParsedOptionsInfo</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/KingfisherWrapper.html">KingfisherWrapper</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/LocalFileImageDataProvider.html">LocalFileImageDataProvider</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/OverlayImageProcessor.html">OverlayImageProcessor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/PropagationError.html">PropagationError</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/RawImageDataProvider.html">RawImageDataProvider</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/RectCorner.html">RectCorner</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/RenderingModeImageModifier.html">RenderingModeImageModifier</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/ResizingImageProcessor.html">ResizingImageProcessor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs.html#/s:10Kingfisher25RetrieveImageDownloadTaskV">RetrieveImageDownloadTask</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/RetrieveImageResult.html">RetrieveImageResult</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/RoundCornerImageProcessor.html">RoundCornerImageProcessor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Structs/TintImageProcessor.html">TintImageProcessor</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher6Buttona">Button</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher5Colora">Color</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher17CompletionHandlera">CompletionHandler</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher21DownloadProgressBlocka">DownloadProgressBlock</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher24DownloadTaskUpdatedBlocka">DownloadTaskUpdatedBlock</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher5Imagea">Image</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher32ImageDownloaderCompletionHandlera">ImageDownloaderCompletionHandler</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher28ImageDownloaderProgressBlocka">ImageDownloaderProgressBlock</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher9ImageViewa">ImageView</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/IndicatorView">IndicatorView</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher13IndicatorViewa">IndicatorView</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/KFCrossPlatformButton">KFCrossPlatformButton</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher21KFCrossPlatformButtona">KFCrossPlatformButton</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/KFCrossPlatformColor">KFCrossPlatformColor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformColora">KFCrossPlatformColor</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/KFCrossPlatformImage">KFCrossPlatformImage</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/KFCrossPlatformImageView">KFCrossPlatformImageView</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher24KFCrossPlatformImageViewa">KFCrossPlatformImageView</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/KFCrossPlatformView">KFCrossPlatformView</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher19KFCrossPlatformViewa">KFCrossPlatformView</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher27PrefetcherCompletionHandlera">PrefetcherCompletionHandler</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher23PrefetcherProgressBlocka">PrefetcherProgressBlock</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher33PrefetcherSourceCompletionHandlera">PrefetcherSourceCompletionHandler</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher29PrefetcherSourceProgressBlocka">PrefetcherSourceProgressBlock</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher11Transformera">Transformer</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:10Kingfisher4Viewa">View</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">

        <section class="section">
          <div class="section-content top-matter">
            <h1>KingfisherWrapper</h1>
              <div class="declaration">
                <div class="language">
                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">KingfisherWrapper</span><span class="o">&lt;</span><span class="kt">Base</span><span class="o">&gt;</span></code></pre>

                </div>
              </div>
            <p>Wrapper for Kingfisher compatible types. This type provides an extension point for
connivence methods in Kingfisher.</p>

          </div>
        </section>

        <section class="section">
          <div class="section-content">
            <div class="task-group">
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperV4basexvp"></a>
                    <a name="//apple_ref/swift/Property/base" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperV4basexvp">base</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">base</span><span class="p">:</span> <span class="kt">Base</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/General/Kingfisher.swift#L">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVyACyxGxcfc"></a>
                    <a name="//apple_ref/swift/Method/init(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVyACyxGxcfc">init(_:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="n">_</span> <span class="nv">base</span><span class="p">:</span> <span class="kt">Base</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/General/Kingfisher.swift#L54-L56">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Available%20where%20%60Base%60:%20%60UIApplication%60"></a>
                <a name="//apple_ref/swift/Section/Available where `Base`: `UIApplication`" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Available%20where%20%60Base%60:%20%60UIApplication%60"></a>
                  <h3 class="section-name"><p>Available where <code>Base</code>: <code>UIApplication</code></p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo13UIApplicationCRbzlE6sharedAESgvpZ"></a>
                    <a name="//apple_ref/swift/Variable/shared" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo13UIApplicationCRbzlE6sharedAESgvpZ">shared</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">shared</span><span class="p">:</span> <span class="kt">UIApplication</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Cache/ImageCache.swift#L796-L800">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Setting%20Image"></a>
                <a name="//apple_ref/swift/Section/Setting Image" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Setting%20Image"></a>
                  <h3 class="section-name"><p>Setting Image</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE8setImage4with11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA6SourceOSg_AA11Placeholder_pSgSayAA0A15OptionsInfoItemOGSgys5Int64V_AYtcSgyAA6ResultOyAA08RetrievefV0VAA0A5ErrorOGcSgtF"></a>
                    <a name="//apple_ref/swift/Method/setImage(with:placeholder:options:progressBlock:completionHandler:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE8setImage4with11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA6SourceOSg_AA11Placeholder_pSgSayAA0A15OptionsInfoItemOGSgys5Int64V_AYtcSgyAA6ResultOyAA08RetrievefV0VAA0A5ErrorOGcSgtF">setImage(with:placeholder:options:progressBlock:completionHandler:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Sets an image to the image view with a <code><a href="../Enums/Source.html">Source</a></code>.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>This is the easiest way to use Kingfisher to boost the image setting process from a source. Since all parameters
have a default value except the <code>source</code>, you can set an image from a certain URL to an image view like this:</p>

</div>
<pre class="highlight swift"><code><span class="c1">// Set image from a network source.</span>
<span class="k">let</span> <span class="nv">url</span> <span class="o">=</span> <span class="kt">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span> <span class="s">"https://example.com/image.png"</span><span class="p">)</span><span class="o">!</span>
<span class="n">imageView</span><span class="o">.</span><span class="n">kf</span><span class="o">.</span><span class="nf">setImage</span><span class="p">(</span><span class="nv">with</span><span class="p">:</span> <span class="o">.</span><span class="nf">network</span><span class="p">(</span><span class="n">url</span><span class="p">))</span>

<span class="c1">// Or set image from a data provider.</span>
<span class="k">let</span> <span class="nv">provider</span> <span class="o">=</span> <span class="kt">LocalFileImageDataProvider</span><span class="p">(</span><span class="nv">fileURL</span><span class="p">:</span> <span class="n">fileURL</span><span class="p">)</span>
<span class="n">imageView</span><span class="o">.</span><span class="n">kf</span><span class="o">.</span><span class="nf">setImage</span><span class="p">(</span><span class="nv">with</span><span class="p">:</span> <span class="o">.</span><span class="nf">provider</span><span class="p">(</span><span class="n">provider</span><span class="p">))</span>
</code></pre>

<p>For both <code>.network</code> and <code>.provider</code> source, there are corresponding view extension methods. So the code
above is equivalent to:</p>
<pre class="highlight swift"><code><span class="n">imageView</span><span class="o">.</span><span class="n">kf</span><span class="o">.</span><span class="nf">setImage</span><span class="p">(</span><span class="nv">with</span><span class="p">:</span> <span class="n">url</span><span class="p">)</span>
<span class="n">imageView</span><span class="o">.</span><span class="n">kf</span><span class="o">.</span><span class="nf">setImage</span><span class="p">(</span><span class="nv">with</span><span class="p">:</span> <span class="n">provider</span><span class="p">)</span>
</code></pre>

<p>Internally, this method will use <code><a href="../Classes/KingfisherManager.html">KingfisherManager</a></code> to get the source.
Since this method will perform UI changes, you must call it from the main thread.
Both <code>progressBlock</code> and <code>completionHandler</code> will be also executed in the main thread.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">setImage</span><span class="p">(</span>
    <span class="n">with</span> <span class="nv">source</span><span class="p">:</span> <span class="kt"><a href="../Enums/Source.html">Source</a></span><span class="p">?,</span>
    <span class="nv">placeholder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Placeholder.html">Placeholder</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">progressBlock</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher21DownloadProgressBlocka">DownloadProgressBlock</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">((</span><span class="kt"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt"><a href="../Structs/RetrieveImageResult.html">RetrieveImageResult</a></span><span class="p">,</span> <span class="kt"><a href="../Enums/KingfisherError.html">KingfisherError</a></span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>source</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The <code><a href="../Enums/Source.html">Source</a></code> object defines data information from network or a data provider.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>placeholder</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>A placeholder to show while retrieving the image from the given <code>resource</code>.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>options</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>An options set to define image setting behaviors. See <code><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></code> for more.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>progressBlock</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image downloading progress gets updated. If the response does not contain an
           <code>expectedContentLength</code>, this block will not be called.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>completionHandler</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image retrieved and set finished.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A task represents the image downloading.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/ImageView+Kingfisher.swift#L77-L170">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE8setImage4with11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA8Resource_pSg_AA11Placeholder_pSgSayAA0A15OptionsInfoItemOGSgys5Int64V_AXtcSgyAA6ResultOyAA08RetrievefV0VAA0A5ErrorOGcSgtF"></a>
                    <a name="//apple_ref/swift/Method/setImage(with:placeholder:options:progressBlock:completionHandler:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE8setImage4with11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA8Resource_pSg_AA11Placeholder_pSgSayAA0A15OptionsInfoItemOGSgys5Int64V_AXtcSgyAA6ResultOyAA08RetrievefV0VAA0A5ErrorOGcSgtF">setImage(with:placeholder:options:progressBlock:completionHandler:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Sets an image to the image view with a requested resource.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>This is the easiest way to use Kingfisher to boost the image setting process from network. Since all parameters
have a default value except the <code>resource</code>, you can set an image from a certain URL to an image view like this:</p>

</div>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">url</span> <span class="o">=</span> <span class="kt">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span> <span class="s">"https://example.com/image.png"</span><span class="p">)</span><span class="o">!</span>
<span class="n">imageView</span><span class="o">.</span><span class="n">kf</span><span class="o">.</span><span class="nf">setImage</span><span class="p">(</span><span class="nv">with</span><span class="p">:</span> <span class="n">url</span><span class="p">)</span>
</code></pre>

<p>Internally, this method will use <code><a href="../Classes/KingfisherManager.html">KingfisherManager</a></code> to get the requested resource, from either cache
or network. Since this method will perform UI changes, you must call it from the main thread.
Both <code>progressBlock</code> and <code>completionHandler</code> will be also executed in the main thread.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">setImage</span><span class="p">(</span>
    <span class="n">with</span> <span class="nv">resource</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Resource.html">Resource</a></span><span class="p">?,</span>
    <span class="nv">placeholder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Placeholder.html">Placeholder</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">progressBlock</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher21DownloadProgressBlocka">DownloadProgressBlock</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">((</span><span class="kt"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt"><a href="../Structs/RetrieveImageResult.html">RetrieveImageResult</a></span><span class="p">,</span> <span class="kt"><a href="../Enums/KingfisherError.html">KingfisherError</a></span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>resource</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The <code><a href="../Protocols/Resource.html">Resource</a></code> object contains information about the resource.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>placeholder</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>A placeholder to show while retrieving the image from the given <code>resource</code>.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>options</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>An options set to define image setting behaviors. See <code><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></code> for more.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>progressBlock</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image downloading progress gets updated. If the response does not contain an
           <code>expectedContentLength</code>, this block will not be called.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>completionHandler</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image retrieved and set finished.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A task represents the image downloading.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/ImageView+Kingfisher.swift#L197-L210">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE8setImage4with11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA0F12DataProvider_pSg_AA11Placeholder_pSgSayAA0A15OptionsInfoItemOGSgys5Int64V_AXtcSgyAA6ResultOyAA08RetrievefW0VAA0A5ErrorOGcSgtF"></a>
                    <a name="//apple_ref/swift/Method/setImage(with:placeholder:options:progressBlock:completionHandler:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE8setImage4with11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA0F12DataProvider_pSg_AA11Placeholder_pSgSayAA0A15OptionsInfoItemOGSgys5Int64V_AXtcSgyAA6ResultOyAA08RetrievefW0VAA0A5ErrorOGcSgtF">setImage(with:placeholder:options:progressBlock:completionHandler:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Sets an image to the image view with a data provider.</p>

<p>Internally, this method will use <code><a href="../Classes/KingfisherManager.html">KingfisherManager</a></code> to get the image data, from either cache
or the data provider. Since this method will perform UI changes, you must call it from the main thread.
Both <code>progressBlock</code> and <code>completionHandler</code> will be also executed in the main thread.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">setImage</span><span class="p">(</span>
    <span class="n">with</span> <span class="nv">provider</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ImageDataProvider.html">ImageDataProvider</a></span><span class="p">?,</span>
    <span class="nv">placeholder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Placeholder.html">Placeholder</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">progressBlock</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher21DownloadProgressBlocka">DownloadProgressBlock</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">((</span><span class="kt"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt"><a href="../Structs/RetrieveImageResult.html">RetrieveImageResult</a></span><span class="p">,</span> <span class="kt"><a href="../Enums/KingfisherError.html">KingfisherError</a></span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>provider</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The <code><a href="../Protocols/ImageDataProvider.html">ImageDataProvider</a></code> object contains information about the data.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>placeholder</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>A placeholder to show while retrieving the image from the given <code>resource</code>.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>options</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>An options set to define image setting behaviors. See <code><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></code> for more.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>progressBlock</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image downloading progress gets updated. If the response does not contain an
           <code>expectedContentLength</code>, this block will not be called.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>completionHandler</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image retrieved and set finished.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A task represents the image downloading.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/ImageView+Kingfisher.swift#L228-L241">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Cancelling%20Downloading%20Task"></a>
                <a name="//apple_ref/swift/Section/Cancelling Downloading Task" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Cancelling%20Downloading%20Task"></a>
                  <h3 class="section-name"><p>Cancelling Downloading Task</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE18cancelDownloadTaskyyF"></a>
                    <a name="//apple_ref/swift/Method/cancelDownloadTask()" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE18cancelDownloadTaskyyF">cancelDownloadTask()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Cancels the image download task of the image view if it is running.
Nothing will happen if the downloading has already finished.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancelDownloadTask</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/ImageView+Kingfisher.swift#L247-L249">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Properties"></a>
                <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Properties"></a>
                  <h3 class="section-name"><p>Properties</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE14taskIdentifierSuSgvp"></a>
                    <a name="//apple_ref/swift/Property/taskIdentifier" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE14taskIdentifierSuSgvp">taskIdentifier</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">taskIdentifier</span><span class="p">:</span> <span class="kt"><a href="../Enums/Source.html">Source</a></span><span class="o">.</span><span class="kt">Identifier</span><span class="o">.</span><span class="kt">Value</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/ImageView+Kingfisher.swift#L303-L312">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE13indicatorTypeAA09IndicatorF0Ovp"></a>
                    <a name="//apple_ref/swift/Property/indicatorType" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE13indicatorTypeAA09IndicatorF0Ovp">indicatorType</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Holds which indicator type is going to be used.
Default is <code>.none</code>, means no indicator will be shown while downloading.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">indicatorType</span><span class="p">:</span> <span class="kt"><a href="../Enums/IndicatorType.html">IndicatorType</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/ImageView+Kingfisher.swift#L316-L331">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE9indicatorAA9Indicator_pSgvp"></a>
                    <a name="//apple_ref/swift/Property/indicator" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE9indicatorAA9Indicator_pSgvp">indicator</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Holds any type that conforms to the protocol <code><a href="../Protocols/Indicator.html">Indicator</a></code>.
The protocol <code><a href="../Protocols/Indicator.html">Indicator</a></code> has a <code>view</code> property that will be shown when loading an image.
It will be <code>nil</code> if <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE13indicatorTypeAA09IndicatorF0Ovp">indicatorType</a></code> is <code>.none</code>.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">indicator</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Indicator.html">Indicator</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/ImageView+Kingfisher.swift#L336-L379">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE11placeholderAA11Placeholder_pSgvp"></a>
                    <a name="//apple_ref/swift/Property/placeholder" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE11placeholderAA11Placeholder_pSgvp">placeholder</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Represents the <code><a href="../Protocols/Placeholder.html">Placeholder</a></code> used for this image view. A <code><a href="../Protocols/Placeholder.html">Placeholder</a></code> will be shown in the view while
it is downloading an image.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">placeholder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Placeholder.html">Placeholder</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/ImageView+Kingfisher.swift#L388-L402">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Available%20where%20%60Base%60:%20%60KFCrossPlatformImageView%60"></a>
                <a name="//apple_ref/swift/Section/Available where `Base`: `KFCrossPlatformImageView`" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Available%20where%20%60Base%60:%20%60KFCrossPlatformImageView%60"></a>
                  <h3 class="section-name"><p>Available where <code>Base</code>: <code><a href="../Typealiases.html#/KFCrossPlatformImageView">KFCrossPlatformImageView</a></code></p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE6webURL10Foundation0F0VSgvp"></a>
                    <a name="//apple_ref/swift/Property/webURL" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE6webURL10Foundation0F0VSgvp">webURL</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Gets the image URL bound to this image view.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@available(*, deprecated, message: "Use `taskIdentifier` instead to identify a setting task.")</span>
<span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">webURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/ImageView+Kingfisher.swift#L413-L416">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Setting%20Image2"></a>
                <a name="//apple_ref/swift/Section/Setting Image" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Setting%20Image2"></a>
                  <h3 class="section-name"><p>Setting Image</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE8setImage4with3for11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA6SourceOSg_So14UIControlStateVSo7UIImageCSgSayAA0A15OptionsInfoItemOGSgys5Int64V_A1_tcSgyAA6ResultOyAA08RetrieveeX0VAA0A5ErrorOGcSgtF"></a>
                    <a name="//apple_ref/swift/Method/setImage(with:for:placeholder:options:progressBlock:completionHandler:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE8setImage4with3for11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA6SourceOSg_So14UIControlStateVSo7UIImageCSgSayAA0A15OptionsInfoItemOGSgys5Int64V_A1_tcSgyAA6ResultOyAA08RetrieveeX0VAA0A5ErrorOGcSgtF">setImage(with:for:placeholder:options:progressBlock:completionHandler:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Sets an image to the button for a specified state with a source.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>Internally, this method will use <code><a href="../Classes/KingfisherManager.html">KingfisherManager</a></code> to get the requested source, from either cache
or network. Since this method will perform UI changes, you must call it from the main thread.
Both <code>progressBlock</code> and <code>completionHandler</code> will be also executed in the main thread.</p>

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">setImage</span><span class="p">(</span>
    <span class="n">with</span> <span class="nv">source</span><span class="p">:</span> <span class="kt"><a href="../Enums/Source.html">Source</a></span><span class="p">?,</span>
    <span class="k">for</span> <span class="nv">state</span><span class="p">:</span> <span class="kt">UIControl</span><span class="o">.</span><span class="kt">State</span><span class="p">,</span>
    <span class="nv">placeholder</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">progressBlock</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher21DownloadProgressBlocka">DownloadProgressBlock</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">((</span><span class="kt"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt"><a href="../Structs/RetrieveImageResult.html">RetrieveImageResult</a></span><span class="p">,</span> <span class="kt"><a href="../Enums/KingfisherError.html">KingfisherError</a></span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>source</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The <code><a href="../Enums/Source.html">Source</a></code> object contains information about the image.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>state</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The button state to which the image should be set.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>placeholder</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>A placeholder to show while retrieving the image from the given <code>resource</code>.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>options</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>An options set to define image setting behaviors. See <code><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></code> for more.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>progressBlock</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image downloading progress gets updated. If the response does not contain an
           <code>expectedContentLength</code>, this block will not be called.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>completionHandler</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image retrieved and set finished.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A task represents the image downloading.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/UIButton+Kingfisher.swift#L53-L130">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE8setImage4with3for11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA8Resource_pSg_So14UIControlStateVSo7UIImageCSgSayAA0A15OptionsInfoItemOGSgys5Int64V_A0_tcSgyAA6ResultOyAA08RetrieveeX0VAA0A5ErrorOGcSgtF"></a>
                    <a name="//apple_ref/swift/Method/setImage(with:for:placeholder:options:progressBlock:completionHandler:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE8setImage4with3for11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA8Resource_pSg_So14UIControlStateVSo7UIImageCSgSayAA0A15OptionsInfoItemOGSgys5Int64V_A0_tcSgyAA6ResultOyAA08RetrieveeX0VAA0A5ErrorOGcSgtF">setImage(with:for:placeholder:options:progressBlock:completionHandler:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Sets an image to the button for a specified state with a requested resource.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>Internally, this method will use <code><a href="../Classes/KingfisherManager.html">KingfisherManager</a></code> to get the requested resource, from either cache
or network. Since this method will perform UI changes, you must call it from the main thread.
Both <code>progressBlock</code> and <code>completionHandler</code> will be also executed in the main thread.</p>

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">setImage</span><span class="p">(</span>
    <span class="n">with</span> <span class="nv">resource</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Resource.html">Resource</a></span><span class="p">?,</span>
    <span class="k">for</span> <span class="nv">state</span><span class="p">:</span> <span class="kt">UIControl</span><span class="o">.</span><span class="kt">State</span><span class="p">,</span>
    <span class="nv">placeholder</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">progressBlock</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher21DownloadProgressBlocka">DownloadProgressBlock</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">((</span><span class="kt"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt"><a href="../Structs/RetrieveImageResult.html">RetrieveImageResult</a></span><span class="p">,</span> <span class="kt"><a href="../Enums/KingfisherError.html">KingfisherError</a></span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>resource</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The <code><a href="../Protocols/Resource.html">Resource</a></code> object contains information about the resource.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>state</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The button state to which the image should be set.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>placeholder</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>A placeholder to show while retrieving the image from the given <code>resource</code>.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>options</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>An options set to define image setting behaviors. See <code><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></code> for more.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>progressBlock</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image downloading progress gets updated. If the response does not contain an
           <code>expectedContentLength</code>, this block will not be called.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>completionHandler</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image retrieved and set finished.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A task represents the image downloading.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/UIButton+Kingfisher.swift#L150-L165">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Cancelling%20Downloading%20Task2"></a>
                <a name="//apple_ref/swift/Section/Cancelling Downloading Task" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Cancelling%20Downloading%20Task2"></a>
                  <h3 class="section-name"><p>Cancelling Downloading Task</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE23cancelImageDownloadTaskyyF"></a>
                    <a name="//apple_ref/swift/Method/cancelImageDownloadTask()" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE23cancelImageDownloadTaskyyF">cancelImageDownloadTask()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Cancels the image download task of the button if it is running.
Nothing will happen if the downloading has already finished.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancelImageDownloadTask</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/UIButton+Kingfisher.swift#L171-L173">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Setting%20Background%20Image"></a>
                <a name="//apple_ref/swift/Section/Setting Background Image" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Setting%20Background%20Image"></a>
                  <h3 class="section-name"><p>Setting Background Image</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE18setBackgroundImage4with3for11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA6SourceOSg_So14UIControlStateVSo7UIImageCSgSayAA0A15OptionsInfoItemOGSgys5Int64V_A1_tcSgyAA6ResultOyAA08RetrievefY0VAA0A5ErrorOGcSgtF"></a>
                    <a name="//apple_ref/swift/Method/setBackgroundImage(with:for:placeholder:options:progressBlock:completionHandler:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE18setBackgroundImage4with3for11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA6SourceOSg_So14UIControlStateVSo7UIImageCSgSayAA0A15OptionsInfoItemOGSgys5Int64V_A1_tcSgyAA6ResultOyAA08RetrievefY0VAA0A5ErrorOGcSgtF">setBackgroundImage(with:for:placeholder:options:progressBlock:completionHandler:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Sets a background image to the button for a specified state with a source.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>Internally, this method will use <code><a href="../Classes/KingfisherManager.html">KingfisherManager</a></code> to get the requested source
Since this method will perform UI changes, you must call it from the main thread.
Both <code>progressBlock</code> and <code>completionHandler</code> will be also executed in the main thread.</p>

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">setBackgroundImage</span><span class="p">(</span>
    <span class="n">with</span> <span class="nv">source</span><span class="p">:</span> <span class="kt"><a href="../Enums/Source.html">Source</a></span><span class="p">?,</span>
    <span class="k">for</span> <span class="nv">state</span><span class="p">:</span> <span class="kt">UIControl</span><span class="o">.</span><span class="kt">State</span><span class="p">,</span>
    <span class="nv">placeholder</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">progressBlock</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher21DownloadProgressBlocka">DownloadProgressBlock</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">((</span><span class="kt"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt"><a href="../Structs/RetrieveImageResult.html">RetrieveImageResult</a></span><span class="p">,</span> <span class="kt"><a href="../Enums/KingfisherError.html">KingfisherError</a></span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>source</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The <code><a href="../Enums/Source.html">Source</a></code> object contains information about the image.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>state</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The button state to which the image should be set.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>placeholder</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>A placeholder to show while retrieving the image from the given <code>resource</code>.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>options</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>An options set to define image setting behaviors. See <code><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></code> for more.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>progressBlock</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image downloading progress gets updated. If the response does not contain an
           <code>expectedContentLength</code>, this block will not be called.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>completionHandler</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image retrieved and set finished.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A task represents the image downloading.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/UIButton+Kingfisher.swift#L195-L272">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE18setBackgroundImage4with3for11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA8Resource_pSg_So14UIControlStateVSo7UIImageCSgSayAA0A15OptionsInfoItemOGSgys5Int64V_A0_tcSgyAA6ResultOyAA08RetrievefY0VAA0A5ErrorOGcSgtF"></a>
                    <a name="//apple_ref/swift/Method/setBackgroundImage(with:for:placeholder:options:progressBlock:completionHandler:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE18setBackgroundImage4with3for11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA8Resource_pSg_So14UIControlStateVSo7UIImageCSgSayAA0A15OptionsInfoItemOGSgys5Int64V_A0_tcSgyAA6ResultOyAA08RetrievefY0VAA0A5ErrorOGcSgtF">setBackgroundImage(with:for:placeholder:options:progressBlock:completionHandler:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Sets a background image to the button for a specified state with a requested resource.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>Internally, this method will use <code><a href="../Classes/KingfisherManager.html">KingfisherManager</a></code> to get the requested resource, from either cache
or network. Since this method will perform UI changes, you must call it from the main thread.
Both <code>progressBlock</code> and <code>completionHandler</code> will be also executed in the main thread.</p>

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">setBackgroundImage</span><span class="p">(</span>
    <span class="n">with</span> <span class="nv">resource</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Resource.html">Resource</a></span><span class="p">?,</span>
    <span class="k">for</span> <span class="nv">state</span><span class="p">:</span> <span class="kt">UIControl</span><span class="o">.</span><span class="kt">State</span><span class="p">,</span>
    <span class="nv">placeholder</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">progressBlock</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher21DownloadProgressBlocka">DownloadProgressBlock</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">((</span><span class="kt"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt"><a href="../Structs/RetrieveImageResult.html">RetrieveImageResult</a></span><span class="p">,</span> <span class="kt"><a href="../Enums/KingfisherError.html">KingfisherError</a></span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>resource</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The <code><a href="../Protocols/Resource.html">Resource</a></code> object contains information about the resource.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>state</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The button state to which the image should be set.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>placeholder</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>A placeholder to show while retrieving the image from the given <code>resource</code>.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>options</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>An options set to define image setting behaviors. See <code><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></code> for more.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>progressBlock</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image downloading progress gets updated. If the response does not contain an
           <code>expectedContentLength</code>, this block will not be called.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>completionHandler</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Called when the image retrieved and set finished.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A task represents the image downloading.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/UIButton+Kingfisher.swift#L292-L307">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Cancelling%20Background%20Downloading%20Task"></a>
                <a name="//apple_ref/swift/Section/Cancelling Background Downloading Task" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Cancelling%20Background%20Downloading%20Task"></a>
                  <h3 class="section-name"><p>Cancelling Background Downloading Task</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE33cancelBackgroundImageDownloadTaskyyF"></a>
                    <a name="//apple_ref/swift/Method/cancelBackgroundImageDownloadTask()" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE33cancelBackgroundImageDownloadTaskyyF">cancelBackgroundImageDownloadTask()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Cancels the background image download task of the button if it is running.
Nothing will happen if the downloading has already finished.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancelBackgroundImageDownloadTask</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/UIButton+Kingfisher.swift#L313-L315">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Available%20where%20%60Base%60:%20%60UIButton%60"></a>
                <a name="//apple_ref/swift/Section/Available where `Base`: `UIButton`" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Available%20where%20%60Base%60:%20%60UIButton%60"></a>
                  <h3 class="section-name"><p>Available where <code>Base</code>: <code>UIButton</code></p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE14taskIdentifier3forSuSgSo14UIControlStateV_tF"></a>
                    <a name="//apple_ref/swift/Method/taskIdentifier(for:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE14taskIdentifier3forSuSgSo14UIControlStateV_tF">taskIdentifier(for:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">taskIdentifier</span><span class="p">(</span><span class="k">for</span> <span class="nv">state</span><span class="p">:</span> <span class="kt">UIControl</span><span class="o">.</span><span class="kt">State</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Enums/Source.html">Source</a></span><span class="o">.</span><span class="kt">Identifier</span><span class="o">.</span><span class="kt">Value</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/UIButton+Kingfisher.swift#L327-L329">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE24backgroundTaskIdentifier3forSuSgSo14UIControlStateV_tF"></a>
                    <a name="//apple_ref/swift/Method/backgroundTaskIdentifier(for:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE24backgroundTaskIdentifier3forSuSgSo14UIControlStateV_tF">backgroundTaskIdentifier(for:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">backgroundTaskIdentifier</span><span class="p">(</span><span class="k">for</span> <span class="nv">state</span><span class="p">:</span> <span class="kt">UIControl</span><span class="o">.</span><span class="kt">State</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Enums/Source.html">Source</a></span><span class="o">.</span><span class="kt">Identifier</span><span class="o">.</span><span class="kt">Value</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/UIButton+Kingfisher.swift#L355-L357">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE6webURL3for10Foundation0E0VSgSo14UIControlStateV_tF"></a>
                    <a name="//apple_ref/swift/Method/webURL(for:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE6webURL3for10Foundation0E0VSgSo14UIControlStateV_tF">webURL(for:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Gets the image URL of this button for a specified state.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@available(*, deprecated, message: "Use `taskIdentifier` instead to identify a setting task.")</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">webURL</span><span class="p">(</span><span class="k">for</span> <span class="nv">state</span><span class="p">:</span> <span class="kt">UIControl</span><span class="o">.</span><span class="kt">State</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">URL</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>state</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The state that uses the specified image.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Current URL for image.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/UIButton+Kingfisher.swift#L383-L385">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE16backgroundWebURL3for10Foundation0F0VSgSo14UIControlStateV_tF"></a>
                    <a name="//apple_ref/swift/Method/backgroundWebURL(for:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE16backgroundWebURL3for10Foundation0F0VSgSo14UIControlStateV_tF">backgroundWebURL(for:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Gets the background image URL of this button for a specified state.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@available(*, deprecated, message: "Use `backgroundTaskIdentifier` instead to identify a setting task.")</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">backgroundWebURL</span><span class="p">(</span><span class="k">for</span> <span class="nv">state</span><span class="p">:</span> <span class="kt">UIControl</span><span class="o">.</span><span class="kt">State</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">URL</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>state</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The state that uses the specified background image.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Current URL for image.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Extensions/UIButton+Kingfisher.swift#L392-L394">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Available%20where%20%60Base%60:%20%60KFCrossPlatformImage%60"></a>
                <a name="//apple_ref/swift/Section/Available where `Base`: `KFCrossPlatformImage`" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Available%20where%20%60Base%60:%20%60KFCrossPlatformImage%60"></a>
                  <h3 class="section-name"><p>Available where <code>Base</code>: <code><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></code></p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE5image4data5scale23preloadAllAnimationData14onlyFirstFrameAESg10Foundation0J0V_12CoreGraphics7CGFloatVS2btFZ"></a>
                    <a name="//apple_ref/swift/Method/image(data:scale:preloadAllAnimationData:onlyFirstFrame:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE5image4data5scale23preloadAllAnimationData14onlyFirstFrameAESg10Foundation0J0V_12CoreGraphics7CGFloatVS2btFZ">image(data:scale:preloadAllAnimationData:onlyFirstFrame:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">image</span><span class="p">(</span>
    <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span>
    <span class="nv">scale</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">,</span>
    <span class="nv">preloadAllAnimationData</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span>
    <span class="nv">onlyFirstFrame</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/General/Deprecated.swift#L37-L49">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE8animated4with5scale8duration10preloadAll14onlyFirstFrameAESg10Foundation4DataV_12CoreGraphics7CGFloatVSdS2btFZ"></a>
                    <a name="//apple_ref/swift/Method/animated(with:scale:duration:preloadAll:onlyFirstFrame:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE8animated4with5scale8duration10preloadAll14onlyFirstFrameAESg10Foundation4DataV_12CoreGraphics7CGFloatVSdS2btFZ">animated(with:scale:duration:preloadAll:onlyFirstFrame:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">animated</span><span class="p">(</span>
    <span class="n">with</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span>
    <span class="nv">scale</span><span class="p">:</span> <span class="kt">CGFloat</span> <span class="o">=</span> <span class="mf">1.0</span><span class="p">,</span>
    <span class="nv">duration</span><span class="p">:</span> <span class="kt">TimeInterval</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">,</span>
    <span class="nv">preloadAll</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span>
    <span class="nv">onlyFirstFrame</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/General/Deprecated.swift#L53-L63">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Available%20where%20%60Base%60:%20%60KFCrossPlatformImageView%602"></a>
                <a name="//apple_ref/swift/Section/Available where `Base`: `KFCrossPlatformImageView`" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Available%20where%20%60Base%60:%20%60KFCrossPlatformImageView%602"></a>
                  <h3 class="section-name"><p>Available where <code>Base</code>: <code><a href="../Typealiases.html#/KFCrossPlatformImageView">KFCrossPlatformImageView</a></code></p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE8setImage4with11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA8Resource_pSg_AA11Placeholder_pSgSayAA0A15OptionsInfoItemOGSgys5Int64V_AXtcSgySo0C0CSg_So7NSErrorCSgAA9CacheTypeO10Foundation3URLVSgtcSgtF"></a>
                    <a name="//apple_ref/swift/Method/setImage(with:placeholder:options:progressBlock:completionHandler:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo11UIImageViewCRbzlE8setImage4with11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA8Resource_pSg_AA11Placeholder_pSgSayAA0A15OptionsInfoItemOGSgys5Int64V_AXtcSgySo0C0CSg_So7NSErrorCSgAA9CacheTypeO10Foundation3URLVSgtcSgtF">setImage(with:placeholder:options:progressBlock:completionHandler:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">setImage</span><span class="p">(</span><span class="n">with</span> <span class="nv">resource</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Resource.html">Resource</a></span><span class="p">?,</span>
                     <span class="nv">placeholder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Placeholder.html">Placeholder</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
                     <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
                     <span class="nv">progressBlock</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher21DownloadProgressBlocka">DownloadProgressBlock</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
                     <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher17CompletionHandlera">CompletionHandler</a></span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/General/Deprecated.swift#L147-L162">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Available%20where%20%60Base%60:%20%60UIButton%602"></a>
                <a name="//apple_ref/swift/Section/Available where `Base`: `UIButton`" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Available%20where%20%60Base%60:%20%60UIButton%602"></a>
                  <h3 class="section-name"><p>Available where <code>Base</code>: <code>UIButton</code></p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE8setImage4with3for11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA8Resource_pSg_So14UIControlStateVSo7UIImageCSgSayAA0A15OptionsInfoItemOGSgys5Int64V_A0_tcSgyAV_So7NSErrorCSgAA9CacheTypeO10Foundation3URLVSgtcSgtF"></a>
                    <a name="//apple_ref/swift/Method/setImage(with:for:placeholder:options:progressBlock:completionHandler:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE8setImage4with3for11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA8Resource_pSg_So14UIControlStateVSo7UIImageCSgSayAA0A15OptionsInfoItemOGSgys5Int64V_A0_tcSgyAV_So7NSErrorCSgAA9CacheTypeO10Foundation3URLVSgtcSgtF">setImage(with:for:placeholder:options:progressBlock:completionHandler:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">setImage</span><span class="p">(</span>
    <span class="n">with</span> <span class="nv">resource</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Resource.html">Resource</a></span><span class="p">?,</span>
    <span class="k">for</span> <span class="nv">state</span><span class="p">:</span> <span class="kt">UIControl</span><span class="o">.</span><span class="kt">State</span><span class="p">,</span>
    <span class="nv">placeholder</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">progressBlock</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher21DownloadProgressBlocka">DownloadProgressBlock</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher17CompletionHandlera">CompletionHandler</a></span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/General/Deprecated.swift#L171-L194">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE18setBackgroundImage4with3for11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA8Resource_pSg_So14UIControlStateVSo7UIImageCSgSayAA0A15OptionsInfoItemOGSgys5Int64V_A0_tcSgyAV_So7NSErrorCSgAA9CacheTypeO10Foundation3URLVSgtcSgtF"></a>
                    <a name="//apple_ref/swift/Method/setBackgroundImage(with:for:placeholder:options:progressBlock:completionHandler:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo8UIButtonCRbzlE18setBackgroundImage4with3for11placeholder7options13progressBlock17completionHandlerAA12DownloadTaskVSgAA8Resource_pSg_So14UIControlStateVSo7UIImageCSgSayAA0A15OptionsInfoItemOGSgys5Int64V_A0_tcSgyAV_So7NSErrorCSgAA9CacheTypeO10Foundation3URLVSgtcSgtF">setBackgroundImage(with:for:placeholder:options:progressBlock:completionHandler:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="nf">setBackgroundImage</span><span class="p">(</span>
    <span class="n">with</span> <span class="nv">resource</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Resource.html">Resource</a></span><span class="p">?,</span>
    <span class="k">for</span> <span class="nv">state</span><span class="p">:</span> <span class="kt">UIControl</span><span class="o">.</span><span class="kt">State</span><span class="p">,</span>
    <span class="nv">placeholder</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher0A11OptionsInfoa">KingfisherOptionsInfo</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">progressBlock</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher21DownloadProgressBlocka">DownloadProgressBlock</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher17CompletionHandlera">CompletionHandler</a></span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/General/Deprecated.swift#L198-L221">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Available%20where%20%60Base%60:%20%60KFCrossPlatformImage%602"></a>
                <a name="//apple_ref/swift/Section/Available where `Base`: `KFCrossPlatformImage`" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Available%20where%20%60Base%60:%20%60KFCrossPlatformImage%602"></a>
                  <h3 class="section-name"><p>Available where <code>Base</code>: <code><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></code></p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE5applyyAeA6FilterVF"></a>
                    <a name="//apple_ref/swift/Method/apply(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE5applyyAeA6FilterVF">apply(_:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Applies a <code><a href="../Structs/Filter.html">Filter</a></code> containing <code>CIImage</code> transformer to <code>self</code>.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>Only CG-based images are supported. If any error happens
during transforming, <code>self</code> will be returned.</p>

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">apply</span><span class="p">(</span><span class="n">_</span> <span class="nv">filter</span><span class="p">:</span> <span class="kt"><a href="../Structs/Filter.html">Filter</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>filter</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The filter used to transform <code>self</code>.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A transformed image by input <code><a href="../Structs/Filter.html">Filter</a></code>.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/Filter.swift#L120-L142">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/"></a>
                    <a name="//apple_ref/swift/Property/normalized" class="dashAnchor"></a>
                    <a class="token" href="#/">normalized</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Normalize the image. This getter does nothing on macOS but return the image itself.</p>

                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE10normalizedAEvp"></a>
                    <a name="//apple_ref/swift/Property/normalized" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE10normalizedAEvp">normalized</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Returns normalized image for current <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image.
This method will try to redraw an image with orientation and scale considered.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">normalized</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/Image.swift#L122-L132">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE17pngRepresentation10Foundation4DataVSgyF"></a>
                    <a name="//apple_ref/swift/Method/pngRepresentation()" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE17pngRepresentation10Foundation4DataVSgyF">pngRepresentation()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Returns PNG representation of <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">pngRepresentation</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Data</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>PNG data of image.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/Image.swift#L190-L204">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE18jpegRepresentation18compressionQuality10Foundation4DataVSg12CoreGraphics7CGFloatV_tF"></a>
                    <a name="//apple_ref/swift/Method/jpegRepresentation(compressionQuality:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE18jpegRepresentation18compressionQuality10Foundation4DataVSg12CoreGraphics7CGFloatV_tF">jpegRepresentation(compressionQuality:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Returns JPEG representation of <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">jpegRepresentation</span><span class="p">(</span><span class="nv">compressionQuality</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Data</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>compressionQuality</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The compression quality when converting image to JPEG data.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>JPEG data of image.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/Image.swift#L210-L224">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE17gifRepresentation10Foundation4DataVSgyF"></a>
                    <a name="//apple_ref/swift/Method/gifRepresentation()" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE17gifRepresentation10Foundation4DataVSgyF">gifRepresentation()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Returns GIF representation of <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">gifRepresentation</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Data</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Original GIF data of image.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/Image.swift#L229-L231">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE4data6format10Foundation4DataVSgAA11ImageFormatO_tF"></a>
                    <a name="//apple_ref/swift/Method/data(format:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE4data6format10Foundation4DataVSgAA11ImageFormatO_tF">data(format:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Returns a data representation for <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image, with the <code>format</code> as the format indicator.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">data</span><span class="p">(</span><span class="nv">format</span><span class="p">:</span> <span class="kt"><a href="../Enums/ImageFormat.html">ImageFormat</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Data</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>format</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The format in which the output data should be. If <code>unknown</code>, the <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image will be
                converted in the PNG representation.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>The output data representing.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/Image.swift#L238-L250">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE13animatedImage4data7optionsAESg10Foundation4DataV_AA0E15CreatingOptionsVtFZ"></a>
                    <a name="//apple_ref/swift/Method/animatedImage(data:options:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE13animatedImage4data7optionsAESg10Foundation4DataV_AA0E15CreatingOptionsVtFZ">animatedImage(data:options:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Creates an animated image from a given data and options. Currently only GIF data is supported.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">animatedImage</span><span class="p">(</span><span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Structs/ImageCreatingOptions.html">ImageCreatingOptions</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>data</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The animated image data.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>options</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Options to use when creating the animated image.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>An <code><a href="../Typealiases.html#/s:10Kingfisher5Imagea">Image</a></code> object represents the animated image. It is in form of an array of image frames with a
       certain duration. <code>nil</code> if anything wrong when creating animated image.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/Image.swift#L263-L312">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE5image4data7optionsAESg10Foundation4DataV_AA20ImageCreatingOptionsVtFZ"></a>
                    <a name="//apple_ref/swift/Method/image(data:options:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE5image4data7optionsAESg10Foundation4DataV_AA20ImageCreatingOptionsVtFZ">image(data:options:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Creates an image from a given data and options. <code>.JPEG</code>, <code>.PNG</code> or <code>.GIF</code> is supported. For other
image format, image initializer from system will be used. If no image object could be created from
the given <code>data</code>, <code>nil</code> will be returned.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">image</span><span class="p">(</span><span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Structs/ImageCreatingOptions.html">ImageCreatingOptions</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>data</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The image data representation.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>options</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Options to use when creating the image.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>An <code><a href="../Typealiases.html#/s:10Kingfisher5Imagea">Image</a></code> object represents the image if created. If the <code>data</code> is invalid or not supported, <code>nil</code>
       will be returned.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/Image.swift#L323-L336">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE16downsampledImage4data2to5scaleAESg10Foundation4DataV_So6CGSizeV12CoreGraphics7CGFloatVtFZ"></a>
                    <a name="//apple_ref/swift/Method/downsampledImage(data:to:scale:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE16downsampledImage4data2to5scaleAESg10Foundation4DataV_So6CGSizeV12CoreGraphics7CGFloatVtFZ">downsampledImage(data:to:scale:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Creates a downsampled image from given data to a certain size and scale.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>Different from image <code>resize</code> methods, downsampling will not render the original
input image in pixel format. It does downsampling from the image data, so it is much
more memory efficient and friendly. Choose to use downsampling as possible as you can.</p>

</div>

<p>The input size should be smaller than the size of input image. If it is larger than the
original image size, the result image will be the same size of input without downsampling.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">downsampledImage</span><span class="p">(</span><span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">to</span> <span class="nv">pointSize</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">,</span> <span class="nv">scale</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>data</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The image data contains a JPEG or PNG image.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>pointSize</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The target size in point to which the image should be downsampled.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>scale</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The scale of result image.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A downsampled <code><a href="../Typealiases.html#/s:10Kingfisher5Imagea">Image</a></code> object following the input conditions.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/Image.swift#L353-L369">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Blend%20Mode"></a>
                <a name="//apple_ref/swift/Section/Blend Mode" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Blend%20Mode"></a>
                  <h3 class="section-name"><p>Blend Mode</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE5image13withBlendMode5alpha15backgroundColorAESo07CGBlendG0V_12CoreGraphics7CGFloatVSo7UIColorCSgtF"></a>
                    <a name="//apple_ref/swift/Method/image(withBlendMode:alpha:backgroundColor:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE5image13withBlendMode5alpha15backgroundColorAESo07CGBlendG0V_12CoreGraphics7CGFloatVSo7UIColorCSgtF">image(withBlendMode:alpha:backgroundColor:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">image</span><span class="p">(</span><span class="n">withBlendMode</span> <span class="nv">blendMode</span><span class="p">:</span> <span class="kt">CGBlendMode</span><span class="p">,</span>
                  <span class="nv">alpha</span><span class="p">:</span> <span class="kt">CGFloat</span> <span class="o">=</span> <span class="mf">1.0</span><span class="p">,</span>
                  <span class="nv">backgroundColor</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/KFCrossPlatformColor">KFCrossPlatformColor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageDrawing.swift#L49-L68">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Compositing"></a>
                <a name="//apple_ref/swift/Section/Compositing" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Compositing"></a>
                  <h3 class="section-name"><p>Compositing</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/"></a>
                    <a name="//apple_ref/swift/Method/image(withCompositingOperation:alpha:backgroundColor:)" class="dashAnchor"></a>
                    <a class="token" href="#/">image(withCompositingOperation:alpha:backgroundColor:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Creates image from <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image and apply compositing operation.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>This method only works for CG-based image. For any non-CG-based image, <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> itself is returned.</p>

</div>

                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Round%20Corner"></a>
                <a name="//apple_ref/swift/Section/Round Corner" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Round%20Corner"></a>
                  <h3 class="section-name"><p>Round Corner</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE5image15withRoundRadius3fit15roundingCorners15backgroundColorAE12CoreGraphics7CGFloatV_So6CGSizeVAA10RectCornerVSo7UIColorCSgtF"></a>
                    <a name="//apple_ref/swift/Method/image(withRoundRadius:fit:roundingCorners:backgroundColor:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE5image15withRoundRadius3fit15roundingCorners15backgroundColorAE12CoreGraphics7CGFloatV_So6CGSizeVAA10RectCornerVSo7UIColorCSgtF">image(withRoundRadius:fit:roundingCorners:backgroundColor:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Creates a round corner image from on <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>This method only works for CG-based image. The current image scale is kept.
    For any non-CG-based image, <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> itself is returned.</p>

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">image</span><span class="p">(</span><span class="n">withRoundRadius</span> <span class="nv">radius</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">,</span>
                  <span class="n">fit</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">,</span>
                  <span class="n">roundingCorners</span> <span class="nv">corners</span><span class="p">:</span> <span class="kt"><a href="../Structs/RectCorner.html">RectCorner</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">all</span><span class="p">,</span>
                  <span class="nv">backgroundColor</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/KFCrossPlatformColor">KFCrossPlatformColor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>radius</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The round corner radius of creating image.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>size</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The target size of creating image.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>corners</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The target corners which will be applied rounding.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>backgroundColor</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The background color for the output image</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>An image with round corner of <code>self</code>.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageDrawing.swift#L115-L165">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Resizing"></a>
                <a name="//apple_ref/swift/Section/Resizing" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Resizing"></a>
                  <h3 class="section-name"><p>Resizing</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE6resize2toAESo6CGSizeV_tF"></a>
                    <a name="//apple_ref/swift/Method/resize(to:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE6resize2toAESo6CGSizeV_tF">resize(to:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Resizes <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image to an image with new size.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    This method only works for CG-based image. The current image scale is kept.
    For any non-CG-based image, <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> itself is returned.

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">resize</span><span class="p">(</span><span class="n">to</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>size</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The target size in point.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>An image with new size.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageDrawing.swift#L187-L202">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE6resize2to3forAESo6CGSizeV_AA11ContentModeOtF"></a>
                    <a name="//apple_ref/swift/Method/resize(to:for:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE6resize2to3forAESo6CGSizeV_AA11ContentModeOtF">resize(to:for:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Resizes <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image to an image of new size, respecting the given content mode.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>This method only works for CG-based image. The current image scale is kept.
    For any non-CG-based image, <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> itself is returned.</p>

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">resize</span><span class="p">(</span><span class="n">to</span> <span class="nv">targetSize</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">,</span> <span class="k">for</span> <span class="nv">contentMode</span><span class="p">:</span> <span class="kt"><a href="../Enums/ContentMode.html">ContentMode</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>targetSize</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The target size in point.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>contentMode</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Content mode of output image should be.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>An image with new size.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageDrawing.swift#L213-L216">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Cropping"></a>
                <a name="//apple_ref/swift/Section/Cropping" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Cropping"></a>
                  <h3 class="section-name"><p>Cropping</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE4crop2to8anchorOnAESo6CGSizeV_So7CGPointVtF"></a>
                    <a name="//apple_ref/swift/Method/crop(to:anchorOn:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE4crop2to8anchorOnAESo6CGSizeV_So7CGPointVtF">crop(to:anchorOn:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Crops <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image to a new size with a given anchor.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>This method only works for CG-based image. The current image scale is kept.
    For any non-CG-based image, <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> itself is returned.</p>

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">crop</span><span class="p">(</span><span class="n">to</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">,</span> <span class="n">anchorOn</span> <span class="nv">anchor</span><span class="p">:</span> <span class="kt">CGPoint</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>size</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The target size.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>anchor</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The anchor point from which the size should be calculated.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>An image with new size.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageDrawing.swift#L228-L241">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Blur"></a>
                <a name="//apple_ref/swift/Section/Blur" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Blur"></a>
                  <h3 class="section-name"><p>Blur</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE7blurred10withRadiusAE12CoreGraphics7CGFloatV_tF"></a>
                    <a name="//apple_ref/swift/Method/blurred(withRadius:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE7blurred10withRadiusAE12CoreGraphics7CGFloatV_tF">blurred(withRadius:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Creates an image with blur effect based on <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>This method only works for CG-based image. The current image scale is kept.
    For any non-CG-based image, <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> itself is returned.</p>

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">blurred</span><span class="p">(</span><span class="n">withRadius</span> <span class="nv">radius</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>radius</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The blur radius should be used when creating blur effect.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>An image with blur effect applied.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageDrawing.swift#L251-L334">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Overlay"></a>
                <a name="//apple_ref/swift/Section/Overlay" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Overlay"></a>
                  <h3 class="section-name"><p>Overlay</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE10overlaying4with8fractionAESo7UIColorC_12CoreGraphics7CGFloatVtF"></a>
                    <a name="//apple_ref/swift/Method/overlaying(with:fraction:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE10overlaying4with8fractionAESo7UIColorC_12CoreGraphics7CGFloatVtF">overlaying(with:fraction:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Creates an image from <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image with a color overlay layer.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>This method only works for CG-based image. The current image scale is kept.
    For any non-CG-based image, <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> itself is returned.</p>

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">overlaying</span><span class="p">(</span><span class="n">with</span> <span class="nv">color</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/KFCrossPlatformColor">KFCrossPlatformColor</a></span><span class="p">,</span> <span class="nv">fraction</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>color</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The color should be use to overlay.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>fraction</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Fraction of input color. From 0.0 to 1.0. 0.0 means solid color,
      1.0 means transparent overlay.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>An image with a color overlay applied.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageDrawing.swift#L347-L373">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Tint"></a>
                <a name="//apple_ref/swift/Section/Tint" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Tint"></a>
                  <h3 class="section-name"><p>Tint</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE6tinted4withAESo7UIColorC_tF"></a>
                    <a name="//apple_ref/swift/Method/tinted(with:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE6tinted4withAESo7UIColorC_tF">tinted(with:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Creates an image from <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image with a color tint.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">tinted</span><span class="p">(</span><span class="n">with</span> <span class="nv">color</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/KFCrossPlatformColor">KFCrossPlatformColor</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>color</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The color should be used to tint <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code></p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>An image with a color tint applied.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageDrawing.swift#L380-L386">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Color%20Control"></a>
                <a name="//apple_ref/swift/Section/Color Control" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Color%20Control"></a>
                  <h3 class="section-name"><p>Color Control</p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE8adjusted10brightness8contrast10saturation7inputEVAE12CoreGraphics7CGFloatV_A3MtF"></a>
                    <a name="//apple_ref/swift/Method/adjusted(brightness:contrast:saturation:inputEV:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE8adjusted10brightness8contrast10saturation7inputEVAE12CoreGraphics7CGFloatV_A3MtF">adjusted(brightness:contrast:saturation:inputEV:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Create an image from <code>self</code> with color control.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">adjusted</span><span class="p">(</span><span class="nv">brightness</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">,</span> <span class="nv">contrast</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">,</span> <span class="nv">saturation</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">,</span> <span class="nv">inputEV</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>brightness</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Brightness changing to image.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>contrast</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Contrast changing to image.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>saturation</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Saturation changing to image.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>inputEV</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>InputEV changing to image.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>An image with color control applied.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageDrawing.swift#L398-L404">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE6scaled2toAE12CoreGraphics7CGFloatV_tF"></a>
                    <a name="//apple_ref/swift/Method/scaled(to:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE6scaled2toAE12CoreGraphics7CGFloatV_tF">scaled(to:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Return an image with given scale.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">scaled</span><span class="p">(</span><span class="n">to</span> <span class="nv">scale</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>scale</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Target scale factor the new image should have.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>The image with target scale. If the base image is already in the scale, <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> will be returned.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageDrawing.swift#L410-L419">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Available%20where%20%60Base%60:%20%60KFCrossPlatformImage%603"></a>
                <a name="//apple_ref/swift/Section/Available where `Base`: `KFCrossPlatformImage`" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Available%20where%20%60Base%60:%20%60KFCrossPlatformImage%603"></a>
                  <h3 class="section-name"><p>Available where <code>Base</code>: <code><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></code></p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE7decodedAEvp"></a>
                    <a name="//apple_ref/swift/Property/decoded" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE7decodedAEvp">decoded</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Returns the decoded image of the <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image. It will draw the image in a plain context and return the data
from it. This could improve the drawing performance when an image is just created from data but not yet
displayed for the first time.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    This method only works for CG-based image. The current image scale is kept.
    For any non-CG-based image or animated image, <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> itself is returned.

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">decoded</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageDrawing.swift#L431">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE7decoded5scaleAE12CoreGraphics7CGFloatV_tF"></a>
                    <a name="//apple_ref/swift/Method/decoded(scale:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo7UIImageCRbzlE7decoded5scaleAE12CoreGraphics7CGFloatV_tF">decoded(scale:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Returns decoded image of the <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> image at a given scale. It will draw the image in a plain context and
return the data from it. This could improve the drawing performance when an image is just created from
data but not yet displayed for the first time.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    <p>This method only works for CG-based image. The current image scale is kept.
    For any non-CG-based image or animated image, <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> itself is returned.</p>

</div>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">decoded</span><span class="p">(</span><span class="nv">scale</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Typealiases.html#/s:10Kingfisher20KFCrossPlatformImagea">KFCrossPlatformImage</a></span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>scale</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The given scale of target image should be.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>The decoded image ready to be displayed.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageDrawing.swift#L442-L460">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Available%20where%20%60Base%60%20==%20%60Data%60"></a>
                <a name="//apple_ref/swift/Section/Available where `Base` == `Data`" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Available%20where%20%60Base%60%20==%20%60Data%60"></a>
                  <h3 class="section-name"><p>Available where <code>Base</code> == <code>Data</code></p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAA10Foundation4DataVRszlE11imageFormatAA05ImageF0Ovp"></a>
                    <a name="//apple_ref/swift/Property/imageFormat" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAA10Foundation4DataVRszlE11imageFormatAA05ImageF0Ovp">imageFormat</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Gets the image format corresponding to the data.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">imageFormat</span><span class="p">:</span> <span class="kt"><a href="../Enums/ImageFormat.html">ImageFormat</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageFormat.swift#L88-L111">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAA10Foundation4DataVRszlE8contains4jpegSbAA11ImageFormatO10JPEGMarkerO_tF"></a>
                    <a name="//apple_ref/swift/Method/contains(jpeg:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAA10Foundation4DataVRszlE8contains4jpegSbAA11ImageFormatO10JPEGMarkerO_tF">contains(jpeg:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Undocumented</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">contains</span><span class="p">(</span><span class="n">jpeg</span> <span class="nv">marker</span><span class="p">:</span> <span class="kt"><a href="../Enums/ImageFormat.html">ImageFormat</a></span><span class="o">.</span><span class="kt">JPEGMarker</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Image/ImageFormat.swift#L113-L130">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Available%20where%20%60Base%60%20==%20%60CGSize%60"></a>
                <a name="//apple_ref/swift/Section/Available where `Base` == `CGSize`" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Available%20where%20%60Base%60%20==%20%60CGSize%60"></a>
                  <h3 class="section-name"><p>Available where <code>Base</code> == <code>CGSize</code></p>
</h3>
                </div>
              </div>
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo6CGSizeVRszlE6resize2to3forA2E_AA11ContentModeOtF"></a>
                    <a name="//apple_ref/swift/Method/resize(to:for:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo6CGSizeVRszlE6resize2to3forA2E_AA11ContentModeOtF">resize(to:for:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Returns a size by resizing the <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> size to a target size under a given content mode.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">resize</span><span class="p">(</span><span class="n">to</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">,</span> <span class="k">for</span> <span class="nv">contentMode</span><span class="p">:</span> <span class="kt"><a href="../Enums/ContentMode.html">ContentMode</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">CGSize</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>size</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The target size to resize to.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>contentMode</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Content mode of the target size should be when resizing.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>The resized size under the given <code><a href="../Enums/ContentMode.html">ContentMode</a></code>.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Utility/SizeExtensions.swift#L38-L47">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo6CGSizeVRszlE11constrainedyA2EF"></a>
                    <a name="//apple_ref/swift/Method/constrained(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo6CGSizeVRszlE11constrainedyA2EF">constrained(_:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Returns a size by resizing the <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> size by making it aspect fitting the given <code>size</code>.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">constrained</span><span class="p">(</span><span class="n">_</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">CGSize</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>size</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The size in which the <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> should fit in.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>The size fitted in by the input <code>size</code>, while keeps <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> aspect.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Utility/SizeExtensions.swift#L53-L60">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo6CGSizeVRszlE7fillingyA2EF"></a>
                    <a name="//apple_ref/swift/Method/filling(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo6CGSizeVRszlE7fillingyA2EF">filling(_:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Returns a size by resizing the <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> size by making it aspect filling the given <code>size</code>.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">filling</span><span class="p">(</span><span class="n">_</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">CGSize</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>size</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The size in which the <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> should fill.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>The size be filled by the input <code>size</code>, while keeps <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> aspect.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Utility/SizeExtensions.swift#L66-L73">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:10Kingfisher0A7WrapperVAASo6CGSizeVRszlE15constrainedRect3for6anchorSo6CGRectVAE_So7CGPointVtF"></a>
                    <a name="//apple_ref/swift/Method/constrainedRect(for:anchor:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:10Kingfisher0A7WrapperVAASo6CGSizeVRszlE15constrainedRect3for6anchorSo6CGRectVAE_So7CGPointVtF">constrainedRect(for:anchor:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Returns a <code>CGRect</code> for which the <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> size is constrained to an input <code>size</code> at a given <code>anchor</code> point.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">constrainedRect</span><span class="p">(</span><span class="k">for</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">,</span> <span class="nv">anchor</span><span class="p">:</span> <span class="kt">CGPoint</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">CGRect</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>size</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The size in which the <code><a href="../Structs/KingfisherWrapper.html#/s:10Kingfisher0A7WrapperV4basexvp">base</a></code> should be constrained to.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>anchor</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>An anchor point in which the size constraint should happen.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>The result <code>CGRect</code> for the constraint operation.</p>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Kingfisher/tree/5.12.0/Sources/Utility/SizeExtensions.swift#L81-L92">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </div>
        </section>

      </article>
    </div>
    <section class="footer">
      <p>&copy; 2019 <a class="link" href="https://onevcat.com" target="_blank" rel="external">Wei Wang</a>. All rights reserved. (Last updated: 2019-12-13)</p>
      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
    </section>
  </body>
</div>
</html>
